Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Content: Versioning (Fix multi-version navigation) #86

Merged
merged 1 commit into from
Jan 12, 2021
Merged

Documentation Content: Versioning (Fix multi-version navigation) #86

merged 1 commit into from
Jan 12, 2021

Conversation

nate-double-u
Copy link
Contributor

@nate-double-u nate-double-u commented Dec 30, 2020 •
edited
Loading

Updating version selector dropdown

  • Allowing switching between historical versions of the same page

Removing hardcoded "v" from version code

  • Potentially, not all versions will need to start with "v"

Updating hero.html

  • correcting "Docs" button size

Deploy preview: https://deploy-preview-86--etcd.netlify.app/
Latest docs page: https://deploy-preview-86--etcd.netlify.app/docs/v3.4.0/
Sample deprecated page: https://deploy-preview-86--etcd.netlify.app/docs/v3.3.13/metrics/

fixes: #82

@nate-double-u
Copy link
Contributor Author

nate-double-u commented Dec 30, 2020 •
edited
Loading

Todo:

  • Add deprecation warning for non-current versions
  • Build better 404: version 2 has a very different structure than the v3 pages, and a lot of 404s happen when switching between them. See issue Cleanup #87 for 404s.
  • Reintroduce (latest) marker for dropdown (optional -- if we decide to migrate the documentation out of the code repo, we may want to have a current or `main' version instead of a vX.Y.Z)
  • Correct "Versions of this doc" nav bar (broken in initial versioning, fixed in subsequent push)

@nate-double-u
Copy link
Contributor Author

/cc @jberkus @spzala

@nate-double-u nate-double-u mentioned this pull request Dec 30, 2020
Closed
1 task
@nate-double-u nate-double-u changed the title Fix multi-version navigation Documentation Content: Versioning (Fix multi-version navigation) Dec 30, 2020
@nate-double-u
Copy link
Contributor Author

Since 404s are separated out into the Cleanup section of the the Etcd.io Docs/SEO Improvement Plan I've opened another issue to deal with them.

@nate-double-u nate-double-u marked this pull request as ready for review December 30, 2020 19:11
@nate-double-u nate-double-u marked this pull request as draft December 31, 2020 20:40
@nate-double-u
Copy link
Contributor Author

Latest push introduces the deprecation warning.

@nate-double-u nate-double-u marked this pull request as ready for review January 1, 2021 00:35
@nate-double-u
Copy link
Contributor Author

Last push fixes a deprecation warning location issue on section pages.

@nate-double-u
Fix multi-version navigation
3cb51f6 
Updating version selector dropdown
* Allowing switching between historical versions of the same page
* Adding deprecation warning for non-latest versions

Removing hardcoded "v" from version code
* Potentially, not all versions will need to start with "v"

Updating hero.html
* correcting "Docs" button size

fixes: etcd-io#82

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
@nate-double-u
Copy link
Contributor Author

Latest push removes the "v" from the urls in layouts/index.redirects. This fixes the 404 page's /docs/latest link.

@nate-double-u nate-double-u mentioned this pull request Jan 1, 2021
Closed
spzala
spzala approved these changes Jan 6, 2021
View reviewed changes
Copy link
Member

@spzala spzala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Thanks @nate-double-u

@spzala
Copy link
Member

spzala commented Jan 6, 2021

cc @gyuho @xiang90 @jingyih

@nate-double-u nate-double-u mentioned this pull request Jan 8, 2021
Open
2 tasks
@jingyih
Copy link

jingyih commented Jan 12, 2021

This is super cool! Thanks!!

@spzala spzala merged commit 1efbf4d into etcd-io:master Jan 12, 2021
@nate-double-u
Copy link
Contributor Author

Thanks everyone!

@nate-double-u nate-double-u deleted the 82-fix-versioning branch May 28, 2021 00:11
@nate-double-u nate-double-u mentioned this pull request Jun 25, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spzala spzala spzala approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation Content: Versioning
3 participants
@nate-double-u @spzala @jingyih